BasicLogMessage Constructor(LogMessageSeverity,LogWriteMode,String,String,Int32,String,String,Object[])

In This Topic

Creates a BasicLogMessage object with specified LogWriteMode behavior and no attached Exception.

Syntax

Visual Basic
C#

'Declaration
 
Public Function New( _
   ByVal severity As LogMessageSeverity, _
   ByVal writeMode As LogWriteMode, _
   ByVal logSystem As String, _
   ByVal categoryName As String, _
   ByVal skipFrames As Integer, _
   ByVal caption As String, _
   ByVal description As String, _
   ByVal ParamArray args() As Object _
)

public BasicLogMessage( 
   LogMessageSeverity severity,
   LogWriteMode writeMode,
   string logSystem,
   string categoryName,
   int skipFrames,
   string caption,
   string description,
   params object[] args
)

Parameters

severity: The severity of the log message.
writeMode: Whether to queue-and-return or wait-for-commit.
logSystem: The name of the logging system the message was issued through, such as "Trace" or "Gibraltar".
categoryName: The logging category or application subsystem category that the log message is associated with, such as "Trace", "Console", "Exception", or the logger name in Log4Net.
skipFrames: The number of stack frames to skip over to find the first candidate to be identified as the source of the log message.
caption: A simple single-line message caption. (Will not be processed for formatting.)
description: Additional multi-line descriptive message (or may be null) which can be a format string followed by corresponding args.
args: A variable number of arguments referenced by the formatted description string (or no arguments to skip formatting).

Remarks

This constructor creates a BasicLogMessage with a specified LogWriteMode behavior (queue-and-return or wait-for-commit) and will also automatically look for any Exception passed among the params args and attach the first one found as the Exception object for this log message (if any).

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

BasicLogMessage Class
BasicLogMessage Members
Overload List

Send Feedback